Package-level declarations

Types

Link copied to clipboard
@DisableCachingByDefault(because = "Zip based tasks do not benefit from caching")
abstract class BuildPluginTask : Zip

Builds the plugin and prepares the ZIP archive for testing and deployment.

Link copied to clipboard
@CacheableTask
abstract class BuildSearchableOptionsTask : JavaExec, RunnableIdeAware

Builds an index of UI components (searchable options) for the plugin. This task runs a headless IDE instance to collect all the available options provided by the plugin's Settings.

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class CustomRunIdeTask : RunIdeTask, CustomIntelliJPlatformVersionAware

Runs the custom IDE instance using the currently selected IntelliJ Platform with the built plugin loaded. It directly extends the JavaExec Gradle task, which allows for an extensive configuration (system properties, memory management, etc.).

Link copied to clipboard
@Incubating
@UntrackedTask(because = "Should always run")
abstract class CustomTestIdePerformanceTask : TestIdePerformanceTask, CustomIntelliJPlatformVersionAware

Runs performance tests on the IDE with the developed plugin installed.

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class CustomTestIdeTask : Test, TestableAware, CustomIntelliJPlatformVersionAware

Runs plugin tests against the currently selected IntelliJ Platform with the built plugin loaded. It directly extends the Test Gradle task, which allows for an extensive configuration (system properties, memory management, etc.).

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class CustomTestIdeUiTask : TestIdeUiTask, CustomIntelliJPlatformVersionAware

Runs the IDE instance with the developed plugin and robot-server installed and ready for UI testing.

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class InitializeIntelliJPlatformPluginTask : DefaultTask, IntelliJPlatformVersionAware

Initializes the IntelliJ Platform Gradle Plugin and performs various checks, like if the plugin is up-to-date.

Link copied to clipboard
@CacheableTask
abstract class InstrumentCodeTask : DefaultTask, JavaCompilerAware

Task dedicated to executing the code instrumentation using the Ant tasks provided with the currently used IntelliJ Platform dependency.

Link copied to clipboard
@CacheableTask
abstract class JarSearchableOptionsTask : Jar, SandboxAware, PluginAware

Creates a JAR file with searchable options to be distributed with the plugin.

Link copied to clipboard
@CacheableTask
abstract class PatchPluginXmlTask : DefaultTask, IntelliJPlatformVersionAware

Patches plugin.xml files with values provided to the task.

Link copied to clipboard
@CacheableTask
abstract class PrepareSandboxTask : Sync, SandboxProducerAware, SplitModeAware

Prepares a sandbox environment with the installed plugin and its dependencies. The sandbox directory is required by tasks that run IDE and tests in isolation from other instances, like when multiple IntelliJ Platforms are used for testing with RunIdeTask, CustomTestIdeTask, TestIdeUiTask, or TestIdePerformanceTask tasks.

Link copied to clipboard
@CacheableTask
abstract class PrepareTestTask : DefaultTask, TestableAware

This is a task used to prepare an immutable test task and provide all necessary dependencies and configuration for a proper testing configuration.

Link copied to clipboard
@UntrackedTask(because = "Prints output")
abstract class PrintBundledPluginsTask : DefaultTask, IntelliJPlatformVersionAware

Prints the list of bundled plugins available within the currently targeted IntelliJ Platform.

Link copied to clipboard
@UntrackedTask(because = "Prints output")
abstract class PrintProductsReleasesTask : DefaultTask, ProductReleasesValueSource.FilterParameters

Prints the list of binary product releases that, by default, match the currently selected IntelliJ Platform along with IntelliJPlatformExtension.PluginConfiguration.IdeaVersion.sinceBuild and IntelliJPlatformExtension.PluginConfiguration.IdeaVersion.untilBuild properties.

Link copied to clipboard
@UntrackedTask(because = "Output stored remotely")
abstract class PublishPluginTask : DefaultTask

The task for publishing plugin to the remote plugins repository, such as JetBrains Marketplace.

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class RunIdeTask : JavaExec, RunnableIdeAware, SplitModeAware, IntelliJPlatformVersionAware

Runs the IDE instance using the currently selected IntelliJ Platform with the built plugin loaded. It directly extends the JavaExec Gradle task, which allows for an extensive configuration (system properties, memory management, etc.).

Link copied to clipboard
@DisableCachingByDefault(because = "No output state to track")
abstract class SetupDependenciesTask : DefaultTask

A deprecated method for setting up IntelliJ Platform dependencies.

Link copied to clipboard
@CacheableTask
abstract class SignPluginTask : JavaExec, SigningAware

Signs the ZIP archive with the provided key using Marketplace ZIP Signer library.

Link copied to clipboard
@Incubating
@UntrackedTask(because = "Should always run")
abstract class TestIdePerformanceTask : JavaExec, RunnableIdeAware, IntelliJPlatformVersionAware

Runs performance tests on the IDE with the developed plugin installed.

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class TestIdeUiTask : JavaExec, RunnableIdeAware, IntelliJPlatformVersionAware

Runs the IDE instance with the developed plugin and robot-server installed and ready for UI testing.

Link copied to clipboard

Validates the plugin project configuration:

Link copied to clipboard
@CacheableTask
abstract class VerifyPluginSignatureTask : JavaExec, SigningAware

Validates the signature of the plugin archive file using the Marketplace ZIP Signer library.

Link copied to clipboard
@CacheableTask
abstract class VerifyPluginStructureTask : DefaultTask, SandboxAware

Validates completeness and contents of plugin.xml descriptors as well as plugin archive structure.

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class VerifyPluginTask : JavaExec, RuntimeAware, PluginVerifierAware

Runs the IntelliJ Plugin Verifier CLI tool to check the binary compatibility with specified IDE builds.